home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / biblio / bibtex / utils / bibindex / bibindex.txt < prev    next >
Text File  |  1993-05-31  |  3KB  |  133 lines
  1.  
  2.  
  3.  
  4. BIBINDEX(1)          User Commands              BIBINDEX(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      bibindex -    create a bibliography index file for biblook(1)
  10.  
  11. SYNOPSIS
  12.      bibindex basename [[-i] word] [[-i] word] ...
  13.  
  14. DESCRIPTION
  15.      bibindex creates a    compact    binary index file from    a  BibTeX
  16.      bibliography  file    to permit fast lookup by biblook(1).  The
  17.      basename argument can optionally omit  the     .bib  extension.
  18.      The  output index file will be named with the same    basename,
  19.      and extension
  20.  
  21.      For indexing purposes, a  word  is     any  contiguous  set  of
  22.      letters and numbers, after    the following steps:
  23.  
  24.       1.  Letters are folded to lower case.     Thus,    "Voronoi"
  25.           is returned as "voronoi"
  26.  
  27.       2.  All TeX commands,    except those in    math expressions,
  28.           are  removed,  but their arguments are left behind.
  29.           Thus, "Erd{\H o}ss" is returned as "erdos".
  30.  
  31.       3.  All other    non-word characters  are  removed.   Non-
  32.           word  characters    inside {{possibly} nested} braces
  33.           or dollar    signs do not delimit words, so    they  may
  34.           cause  unexpected     results.  Thus, "{this    example}"
  35.           is returned as "thisexample".
  36.  
  37.       4.  TeX commands in  math  expressions  are  considered
  38.           normal text.  Thus, "$O(n\log^2 n)$" is returned as
  39.           "onlog2n"     instead  of  "onn".   This  occasionally
  40.           gives  unexpected    or unreadable results.    For exam-
  41.           ple,  "$\bigcup_1^n[a_i,b_i]$"   is   returned   as
  42.           "bigcup1naibi".
  43.  
  44.       5.  Apostrophes do not delimit words.      Thus,     "didn't"
  45.           is returned as "didnt", and "{\'O}'D{\'u}nlaing" is
  46.           returned as "odunlaing".
  47.  
  48.      bibindex examines the contents of    all  value  strings,  and
  49.      expects  them  to    be well-formed TeX input.  In particular,
  50.      braces and    dollar signs should be balanced.
  51.  
  52.      Errors detected result in a message giving    the  line  number
  53.      of    the BibTeX entry in which the error was    detected, and the
  54.      line number at the    point of the error.  Unbalanced    braces or
  55.      dollar  signs  can    result in large    differences between these
  56.      line numbers; in such a case, the error is    somewhere in  the
  57.      entry indicated by    the first line number.
  58.  
  59.  
  60.  
  61.  
  62.  
  63. Version    2.2      Last change: 03 October 1992            1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. BIBINDEX(1)          User Commands              BIBINDEX(1)
  71.  
  72.  
  73.  
  74. OPTIONS
  75.      -i    keyword
  76.      Add keyword to    the list of BibTeX keywords that  are  to
  77.      be ignored, along with    their string values, in    preparing
  78.      the index.  By    default, all keyword = "value" pairs  are
  79.      indexed.   Any    number of -i switches and keywords may be
  80.      specified.
  81.  
  82. SEE ALSO
  83.      bibclean(1), biblook(1), bibtex(1), latex(1), tex(1)
  84.  
  85. AUTHOR
  86.      Jeff Erickson
  87.      Computer Science Division
  88.      University    of California
  89.      Berkeley, CA 94720
  90.      USA
  91.      Email: <jeff@cs.berkeley.edu>, <jeffe@melody.berkeley.edu>
  92.  
  93.      This program is in    the public domain.  You     may  use  it  or
  94.      modify it to your heart's content,    at your    own risk.
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Version    2.2      Last change: 03 October 1992            2
  130.  
  131.  
  132.  
  133.